home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Gold Medal Software 3
/
Gold Medal Software - Volume 3 (Gold Medal) (1994).iso
/
wordproc
/
hshell1.arj
/
QREF.DOC
< prev
next >
Wrap
Text File
|
1993-12-29
|
75KB
|
1,939 lines
HyperShell Version 5 - Quick Reference Guide
HyperShell Hypertext control system Version 5.0 Quick Reference Guide
Copyright (c) 1989,1990,1991,1992,1993 Text Technology
_______________________________________________________________________
CONTENTS Page
1. Hyperfile Structure
2. HyperShell Directives
3. Print Directives
4. Check directives
5. References
6. Formatting flags
7. System variables
8. Pseudo variables
9. Application variables
10. Limits
11. Actions
12. Extended action codes
13. Bitmap sublanguage commands [G]
14. Draw Sublanguage commands [G]
15. Graphic hook variables [G]
16. Parameters on actions
17. Key specifications
18. Action modifiers
19. Dynamic menus
20. Contents lists
21. Iterators
22. Function codes
23. Expression operators
24. Script control structures
25. Conversion string commands
26. Pattern Match operators
27. Conditions
28. Reserved characters in Actions
29. Options
30. Extended options
31. Colour schemes
32. Colour codes
33. Configuration strings
34. Control menu
35. Error codes
36. Edit actions
37. Extra dynamic menus
38. Flags in lists
39. Extra Functions
40. Environment options
41. Edit mode primitive function codes
42. Graphics symbol shift character mappings
43. Default Key Mappings
44. Control Keys
45. Function Keys
46. HS - HyperShell Reader
47. HI - HyperShell Integrated Environment
48. HC - HyperShell Checker
49. HP - HyperShell Print program
50. HCX - HyperShell Compress program
51. TAGBLOAD - image tagger
52. HYPOP - HyperShell subset popup program
53. HRXFP - HyperShell Floating Point
54. NGHS - Norton Guide to hyperfile convertor
55. NOTE - Simple note editor
56. HSORT - Hyperfile index sort
57. HSHOW - Graphic file display program
58. HPREP - Text preparation program
59. HSPELL - Hyperfile spell check
60. HFIND - File and text finder
61. HTYPE - File browser
62. HSRES - Resident swapper for HyperShell
63. HPAINT - Paint program
64. HRESED - Resource editor
65. HGPREP - HyperShell Graphic Preparation
66. HCOMP - Compression control
67. HLIB - Command line
68. HCAP - capture screens
69. HFONT - Load font file for text mode
70. HPG - Graphic print
71. CONVSND - Convert sound file
72. CTAUDIO - Compact Disc Audio control
73. HyperShell File Extensions
Key:
[IDE] Integrated Development Environment only
[G] Graphic version only (HG.EXE, HGI.EXE, HDG.EXE)
1. Hyperfile Structure
┌───┐ ┌───┐ ┌───────────────┐ ┌─────────────────────────────┐
│ H │ │ G │ │ CONTROL ITEMS │ │ INDEX, HEADER, FOOTER, ETC. │
│ │ │ L │ └───────────────┘ └─────────────────────────────┘
│ Y │ │ O │ ┌───────────────┐ ┌─────────────────────────────┐
│ │ │ B │ │ G E N E R A L │ │ N O T E S │
│ P │ │ A │ │ │ │ M E N U S │
│ │ │ L │ │ I T E M S │ │ S C R I P T S │
│ E │ │ S │ │ │ │ R E M A R K S │
│ │ │ │ │ │ │ PRINT AND CHECK │
│ R │ └───┘ └───────────────┘ └─────────────────────────────┘
│ │ ┌───┐ ┌───────────────┐ ───── ┌──────────────────────┐
│ F │ │ F │ │ F R A M E │ │ FRAME, TITLE, TEXT │
│ │ │ R │ │ S P E C │ └──────────────────────┘
│ I │ │ A │ └───────────────┘ ──┐ ┌──────────────────────┐
│ │ │ M │ ┌───────────────┐ │ │ L O C A L I T E M S │
│ L │ │ E │ │ F R A M E │ │ │ N O T E S │
│ │ │ S │ │ S P E C │ │ │ M E N U S │
│ E │ │ │ └───────────────┘ │ │ S C R I P T S │
└───┘ └───┘ - etc - └── └──────────────────────┘
2. HyperShell Directives
.REMARK Remark section
.PRINT directives HP control
.CHECK settings HC control
.NOTE name Global/Local Note
.MENU name Global/Local Menu
.SCRIPT name Global/Local Script
.HEADER Screen header
.FOOTER Screen footer
.INDEX Create .HIX file
.SHARE Shared globals
.FRAME name Frame name
.TITLE title text Frame title
.END End of frame spec.
3. Print Directives
.PRINT TITLE Next line is title
.PRINT FOOT Next line is footer
.PRINT OFF Disable print
.PRINT ON Enable print
.PRINT PAGE Page break
.PRINT THIS Following text is printed
.PRINT SECTION prefix Prefix for numbering
.PRINT MARGIN nn set frame margin (for ~i flag)
.PRINT WPOFF Disable -w flag
.PRINT WPON Enable -w flag
.PRINT LIMIT nnnn Frame limit for encrypted file
.PRINT LIMIT g Suppress glossary for encrypted
4. Check directives
.CHECK +a - check actions in menus with actions
.CHECK +f - check frame refs for menus without actions
.CHECK +p - suppress frame length check
.CHECK +u - suppress errors for unresolved references
.CHECK +x - suppress menu length check
5. References
~?ref text{~Paction}{~Kk}~E - reference(type(name){,action{,key}})
Where ? is :-
~A Action actionref(ref{,action}{,k})
~F Frame reference frameref(name{,action}{,k})
~f Frame step
~I Input field inputfield(field,pattern{,k})
~M Global menu menuref(name{,action}{,k})
~m Local menu
~N Global note noteref(name{,action}{,k})
~n Local note
~S Global script scriptref(name{,action}{,k})
~s Local script
~t File note
~R [G] Graphic reference
6. Formatting flags
~a Mark top left of area
~Bc Background colour background(colour)
~bn Set bottom right position, draw area as per n box(type)
0 - Just return to position set by ~a _return
1 - Draw box from ~a position _double
2 - Define text window and clear it _window
3 - Draw box with window inside and clear _windowbox
Above values +4 - reset text window to full screen
~Cnn Column (1-78) column(number)
~c Concatenate with next line (stops line break)
~Ds Colour Scheme (A-Z) scheme(letter)
~d Toggle slow (teletype) display
~G Screen break
~g Line break
~H Hidden line
~hc Line/text shown if condition true showif(c)
~in Set indent at 'n' spaces (default 0) indent(by)
~Jn Set local flag setlocal(flag)
~jc Line/text hidden if condition true hideif(c)
~Lnn Line (1-22) linepos(number)
~On Option setting (0-9,other chars,#)
~p Do not PRINT rest of this line
~Q Immediate reference (after reference)
~Tc Text colour foreground(colour)
~Vi Video intensity
~Wnn Field width (1-72) width(number)
~wn Wait n seconds before continuing wait(seconds)
~Xnn Column (1-78) (forced) xpos(number)
~Ynn Line (1-22) (forced) ypos(number)
~Z End of region
~z [G] terminate sunlanguage command
~e [G] terminate command and stop reference (also ~R...~E)
~vx [G] Change font to nn (x=A for nn=1,@ for 0)
~Ux [G] Do bitmap sublanguage command in variable GUx
~ux [G] Do draw sublanguage command in variable Gux
7. System variables
$0 HyperShell program pathname _progpath
$1 Current frame name _frame
$2 Current frame title _title
$3 Current file name _hyperfile
$4 Current date _date
$5 Current time _time
$6 Backtrack list depth _depth
$7 Current directory _curdir
$8 Original directory _original
$9 HyperShell name and version _hypershell
$? Error number of last error _errnum
$@ Remaining memory _memory
$_ File prompt _fprompt
$^ Program exit code _exitstatus
$: Exclusion list of file extns _exclusions
$< Filename from directory display _filename
$> File extension from directory _filetype
$` Error status change action _erroraction
$\ Parameter to Script or Note _parameter
$~ Pattern match translation string _pattrans
8. Pseudo variables
$, represents ';' character _semi
$! represents '|' character _bar
9. Application variables
$A to $Z application variables
$a to $z application variables
$(xxxxxx) named application variable
$(%NAME) value of environment variable
$(=expr) value of expression
$(&func) value of function
10. Limits
Reference text - 40 chars
Reference action - 40 chars
References in frame (+ note) - 100
Note text - 76 chars by 22 lines
Frame text - 80 chars
Menu choices - 20 per page
Script lines - 80 chars by 200
(expanded) action string - 120 chars
multiple action string - 120 chars
11. Actions
Aaction do action 'action' action(action)
acaction do 'action' on condition 'c' ifcond(c,action)
B backtrack one frame backtrack()
bn backtrack to depth n backto(depth)
Cd:d Change drive/directory changeto({d:}dir)
cfile interpret file as script call(scriptfile)
Dcommand Dos shell command dodos(command,wait)
dcommand Dos shell command (no wait) dodos(command{,quiet})
Ecommand Execute command (no return) execute(command,over)
evsabc.. Split v on s to a,b,c etc. expand(v,s,abc...)
Fname{^hf} Go to frame {in hyperfile} frame(name)
fname{^hf} Go to frame (no backtrack) framestep(name)
Gfile Display graphic file graphic(file)
gfile Display graphic and stay in mode graphic(file,hold)
Href~comm Add note to notepad {with comment} addref(ref)
href Remove note from notepad delref(ref)
I{#} Select next{current} input field nextinput({this})
itext Insert text at text cursor insert(text)
Jlabel Unconditional jump goto(label)
jclabel Conditional jump goto(c,label)
Kkkact Map key kk to action mapkey(key,action)
kkkaction Do action mapped to key dokey(key)
Llabel Label name - in script. label(name)
lvnamed Load named var from var v loadvar(v,name)
Mname Global menu menu(name)
mname local menu localmenu(name)
Nname Global note note(name)
nname local note localnote(name)
Oos Set option / colour setopt(opt,val)
ostring Output to printer etc. output(string)
Pstring Popup message popmessage(string)
pstring Display message on bottom line display(string)
Qss Quit to DOS quit(status)
q Quit script quitscript()
Rsabc.. Read file (formatted) read(s,abc...)
rfilenm Open file for reading (close) openin(file), closein()
Sname Global script script(name)
sname local script localscript(name)
Tfilenm Type file typefile(file{,string})
tfilenm Display file as popup note filenote(filename)
Vxvalue Set variable x to value setvar(v,value)
vxvalue Test variable x testvar(v,value)
Wstring Write string to file write(string)
wfilenm Open file for writing (close) openout(file), closeout()
Xcomm Execute command execute(command,wait)
xcomm Execute command (no wait) execute(command)
Y Reset error status to 0 reseterr(value)
y{+/#/-} Display next,current,prev screen refresh(ind)
Zxa Extended action code (see below)
zcaction Do 'action' if 'c' false ifnot(c,action)
12. Extended action codes
ZAkey:action - Specified autoref autoref(key,action)
Za - Autoreference search string
ZB - Beep (sound bell) beep(param)
Zbn - 0=Bright,1=Blink Background blinkback(status)
ZC - Display control menu control()
Zcnn string - Set config string nn to string
ZDpattern - [G] Delete set of named vars
ZE - Exit subroutine return()
ZFn - Reserve footer lines reserve(lines)
ZG - Refresh &X,&Y coords getxy()
Zg - Get graphics mouse selection getseln()
ZH - Hold start position of loop holdline()
ZIexpr - If expr TRUE (+ve), do multiact if(expr)
Ziexpr - If expr non-zero, do multiaction
ZJlabel - Jump to Subroutine gosub(label)
ZLn{s} - Toggle frame local flag toggle(flag,noref)
Zlc{i} - Set local flag for contents ind. localind(flag,ind)
ZMn - Set text mode (n = 3 or 64) textmode(mode)
Zmnn - Set message line number (25)
ZNfilename - Write noted references to file
Zo{t} - Print current frame {with name/title}
ZPfile - Preload hyperfile preload(hyperfile)
ZR - Recall saved screen recall()
Zr - Reset text window to full screen resetwindow()
ZSev=string - Set environment variable setenv(var,value)
ZT - Take copy of whole screen takecopy()
Zt - Show copied screen /clear screen showcopy()
ZUc{tt} - Load character as input {timeout} unget(c)
ZVname=value - Assign named variable assign(name,value)
ZW - [IDE] write to debug trace file
Zw{filename} - [IDE] {open}/close debug trace file
ZXnn - Set mouse cursor column setmousex(xpos)
ZYnn - Set mouse cursor line setmousey(ypos)
ZZ - [G] Graphic bitmap sublanguage
Zz - [G] Graphic draw sublanguage
13. Bitmap sublanguage commands [G]
A Load image as mouse cursor (arrow)
B Position image at box top position - set by ~a
C Get image from last reference selected to general save area
D Load and decompress image (saved with S or X) to general save
E 'Soft' extract - extract if not already loaded
F Load file as font in CHARBIOS (needs CHARBIOS loaded)
G Get image from screen to general save area
H Play file as sound through IBMSND.COM driver
I Invert image (see also +)
J Load image as 256 colour screen (in mode 19 only)
K - reserved -
L Load image from memory with name = item
M Position image at mouse cursor = top left
N - reserved -
O Open library file with name = item (eg. ZZO^GLIB.HLB)
P Put image to screen
Q Test to see if CHARBIOS is loaded, and report an error if not
R Read image from file (filename = item) to general save area
S Save image to memory with name = item
T Position image at current text cursor = top left
U Load file as 16 colour palette (uses .PAL files)
V Read image and save in variable of same name
W Write image to file (filename = item)
X Extract item from library with name = item and store
Yx Tell CHARBIOS to load font x from file (see ~vx description)
Z Sleep - Wait for 20ms
+n Displace image downwards by n pixels (see also I)
1 Specify default image display command string (see section below)
2 Supply pattern for auto-purge of named variables
14. Draw Sublanguage commands [G]
cccc - colour sequence
X - exclusive or the following commands
Hnnn - set horizontal coord (x)
hnnn - set horizontal coord 2 (x) (default is last coord)
Vnnn - set vertical coord (y)
vnnn - set vertical coord 2 (y) (default is last coord)
P - set coordinates to mouse pixel coordinates
Ldnnncccc - horiz/vert lines
d = direction
nnn = repeat
ccc = colour sequence
lc - draw line from coord 2 to specified coord
eg. draw green line from last graphic position to 200,100
ZzH200V100lG
directions
7 8 9
\ | /
4 - - 6
/ | \
1 2 3
colour sequence
- Colour letters as per HyperShell colour values
eg. rrr is three bright red pixels
- T - transparent pixel (leave screen pixel as is)
- , comma - "carriage return / line feed"
- ' quote - vertical "carriage return / line feed"
- . point - "carriage return"
These allow a sequence of raster lines to be drawn
in the required direction
15. Graphic hook variables [G]
Bitmap Sublanguage command strings
GXR Reference selection
GUx executed by ~Ux
GXN Font for use in popup note
GXM Font for use in popup menu
GXT Font for use in main text
GXP Font for display of popup note
GMx Mouse cursor, where x is one of the standard
reference flag letters - A,F,M,S,N or R.
GMT Mouse cursor to that used for open text.
Draw Sublanguage command strings
Gux executed by ~ux
16. Parameters on actions
-- on Frame actions F and f --
Fname Named frame (normal frame selection)
F Home frame (first in file)
F+ Next frame (wrap at end)
F+1 Next matching frame
F+2 Next unmatched frame
F+name Next named (duplicates)
F- Previous frame (wrap at start)
-- on M,m,F --
Mmenu name(option number) Specified option
Mmenu name[lookup key / pattern] Lookup value
Mmenu name[@] Graphics selection zone action
-- on N,n,t,S,s,c --
Nnote name(parameters) Set variable $\
Sscript name(parameters) Set variable $\
-- on T --
Tfilename/string Type file, searching for string
If string starts '^' it is a pattern
Tfilename#nn Type file, starting at page nn
Tfilename#nn/string Type file at page nn and highlight string
17. Key specifications
(kk = F1-F0,S1-S0,A1-A0,C1-C0,#x)
18. Action modifiers
?prompt Prompt for value prompt(prompt)
?prompt/deflt Prompt giving value to edit prompt(prompt,default)
%envvar Use value of env. var getenv(variable)
&funcspec Use function return
@menuspec Use menu return from(menuspec)
!readspec Iterators (read file etc)
=expr Integer/boolean expression
19. Dynamic menus
@B Backtrack list for unwind unwind()
@b Backtrack list for revisit revisit()
@C{n}{key} Current contents list contents(n,key)
@Dwildspec Directory list (no extn) popdir(wild,noext)
@dwildspec Directory list (with extn) popdir(wild)
@Ewildspec Directory (directories) popdirs(wild)
@Ffilename Contents of file as menu filemenu(filename)
@Gfilename Formatted file list datalist(filename)
@Lwildspec Extended directory display directory(wildcard)
@lwildspec Extended dir with actions diraction(wildcard)
@M/mname Global/local menu from(menu(name)) etc.
@N/n/tname Global/local/file note from(note(name)) etc.
@Oxxx Named vars starting xxx as menu
@R Notepad paged list notepad()
@Sstring Search titles of current file search(title,string)
@sstring Search titles of open files search(alltitle,string)
@Xstring Search titles/texts current search(text,string)
@xstring Search titles/texts open fls search(alltext,string)
20. Contents lists
@C{0}{key} Full list {starting with key} full(key)
@C1{key} Matching frames { " } matched(key)
@C2{key} Unmatched frames { " } unmatched(key)
@C3key Start list at frame " startat(key)
@C4key Titles starting with key titlekey(key)
@C4^pattern Titles containing pattern titlekey(key)
@C5key Start at title starting key starttitle(key)
@C5^pattern Start at title containing pattern starttitle(key)
21. Iterators
!{key} Read next {matching} record readrec(key)
!F{key} Read next {matching} record readnext(key)
!L{key} Read first {matching} record lookuprec(key)
!Bkey Fast lookup (sorted text files) fastlookup(key)
!C Next comment comment(key)
!R{key} Next {matching} reference nextref(key)
!Dwildcard First matching filename firstfile(wildcard)
!D Next matching filename nextfile()
!Ppos Position at byte 'pos' and return line
!Sstring Search for first string and return record
!Nstring Search for next string in file
22. Function codes
&Ac - ASCII value of 1st char asc(c)
&an - Name of frame number n
&Bp - Scale value to p decimal places scale(p,value)
&bc - [G] get graphic information (pixel level)
x current graphic draw x coord
y current graphic draw y coord
X mouse x coord
Y mouse y coord
M current mode (as set by ZM action)
C character cell height
&Cn - Character of ASCII value nn chr(nn)
&cparam - HyperShell Resident Extension hrx(param)
&D - Display (0-CGA,1-MDA,2-EGA,3-VGA) adaptor()
&dxnn - String of length nn of character x
&Ekk - Extended key mapping mapping(kk)
&enn - Edit and get text of length nn
&Fcss - String from character c onwards fromchar(c,ss)
&f{d} - [IDE] Free space on cur{named} drive diskfree(d)
&f{#} - [IDE] return space on {hyperfile} disk
&Gtt - Get key with timeout keytimed(timeout)
&gnn - Get text of length nn at text cursor
&H - Time of day as hundredths timehun()
&hcomm - Add ref for matched frames, with comment
&Icss - Position of char c in string ss instr(c,ss)
&i{def} - input string at text cursor position textin(default)
&J - Time difference (hundredths) timediff()
&jname - Sequence number of frame 'name'
&Kss - Key pressed from popup prompt getkey(message)
&kc - Clear all local condition c flags
&Lss - Length of string ss length(ss)
&l - [IDE] Size of current hyperfile filesize()
&Mk - String mapped to key k mapone(k)
&mss - Frame with title containing ss
&Nnss - nth character in string ss. ** nthchar(n,ss)
&n - Current page number in frame
&OX - Application flag value (X=A-Z) flagval(flag)
&oX - Numeric attribute of colour scheme X
&P - Pick word at mouse cursor pickword()
&pn - Last typed file parameters typedparam(n)
&Qn - Pick reference action at mouse pickref(n)
&q - Wait for key press return ASCII code
&Rnn - Run option value (nn = 0 to 21) optval(nn)
&Snss - Substring of ss starting nth. ** frompos(n,ss)
&sname - Local flag mask of frame 'name'
&Tss - Title of frame with name ss title(frame)
&t - Name of last(current) typed file typedfile()
&Ucss - String up to character c upto(c,ss)
&unss - First n characters of string ss. **
&Vnn - Configuration string nn configval(nn)
&vv - Variable address as far pointer varptr(v)
&Wss - Whole string (guard) whole(ss)
&wn - Details of last reference selected.
0 - ASC val of reference type
1 - ref start column
2 - ref line number
3 - ref column after end
4 - ASC val of key mapping
5 - [G] depth of reference
&X - X (column) from graphic seln selcol()
&x - Text cursor column
&Y - Y (line) from graphic seln selline()
&y - Text cursor line
&Z - Key pressed from graphic seln selkey()
&zn - [G] Information about last graphic displayed
&z0 - should have a value of 127, else not valid image
&z1 - character cell depth (8,14 or 16 pixels)
&z2 - left column \
&z3 - top row / the top left corner position
&z4 - width in character cells
$z5 - depth in character cells
vstr - Convert variable 'v' using string convert(v,string)
** n can be single letter variable name
23. Expression operators
+,-,*,/,% - arithmetic operators
expr?true exp:false exp - triadic operation
expr!expr - bitwise OR
expr&expr - bitwise AND
expr^expr - bitwise EXCLUSIVE OR
@expr - 1's complement
-- Boolean expression operators - 1 if TRUE, 0 if FALSE ---
expra>exprb - a greater than b
expra<exprb - a less than b
expra=exprb - a equal to b
~expr - not expr (0->1,1->0)
#c - Truth of condition code 'c'
"vxxxx"c - combined variable comparison and test
24. Script control structures
{ic If true
- if c true statements -
}
{nc If false
- if c false statements -
}
{ic If true
- if c true -
}e{ Else
- if c false -
}
{nc If false
- if c false -
}e{ Else
- if c true -
}
{wc While true
- while c true -
}
{uc Until true
- until c true -
}
{
- while c true, but at least once -
}wc While true
{
- until c true, but at least once -
}uc Until true
{wc While c true
- while c true -
- until d true -
}ud Until d true
{ Loop
- actions -
}
{ Loop
- actions -
}xc{ If true, exit loop
- actions -
}
25. Conversion string commands
l - convert to lowercase
u - convert to uppercase
s - strip superfluous spaces
tv - translate according to variable v
rv - remove characters in variable v
ic - (before command) conditional on 'c'
26. Pattern Match operators
< at start - match start of string
> at end - match end of string
? match any character
_ match one or more space or TAB characters
(alt1/alt2) match alt1 or alt2 (if only one, it is optional)
[abc] match 'a', 'b' or 'c'
[^abc] match any character but 'a','b' or 'c'
[x-y] match any char in range x to y (eg. [a-zA-Z] match letter)
{ start of word
} end of word
x# zero or more of the character or subexpression x
x+ one or more of the character or subexpression x
* any string (equivalent to ?#)
\x character 'x' (allows metachars to be used literally)
& AND conjunction (if multiple searches enabled)
! OR conjunction (if multiple searches enabled)
27. Conditions
e equal _equal
n not equal _notequal
g greater than _greater
l less than _less
d defined _defined
u undefined _undefined
c contains _contains
w contained within _within
m pattern match _match
f pattern fail match _fail
s errorcode set _error
o error code O.K. _ok
r actn mod. returned string _result
b actn mod. returned nothing _noresult
z file operation failure _filerror
A-Z Application flags
v [IDE] set during view mode _viewmode
i [IDE] set for IDE only _IDE
x [G] set for HG,HGI,HDG only
--- Local to frame ---
0-9 local flags
/ matching frame flag _matching
: frame has been visited _visited
< frame over one screen _overscreen
28. Reserved characters in Actions
----- (character 2,3) ------
@ Dynamic menu
& String function
! Read record
= Expression evaluation
% Environment variable
? Prompted input
----- (any character) -----------
$ Variable expansion token
| Action modifier pattern spec
^ (Within frame names) Hyperfile sep
; Multiple action separator
----- (In frame / note text) --------
~ Reference and formatting flag
$ Variable expansion token
. (At beginning of line) Keyword
29. Options
O0 - 0 = Do not produce restart file
1 = Use restart file for notes
2 = Use for notepad, vars and frame
3 = Save references and variables (not frame)
4 = Save variables only
O1 - 0 = Show funct keys, but not symbols
1 = Show symbols
2 = Use 1st letter. Func keys as for frame/list
4 = Immediate menus on top line
O2 - 0 = No backtrack recording
+1 = Record backtrack
+2 = Extended backtrack (to page)
O3 - 0 = No frame extns in notepad
+1 = Add file name as ref extension
+2 = Suppress INS/DEL notepad actions
+4 = Insert / remove current frame always
O4 - 0 = No autoreference
1 = Autoreference frame names
2 = Application specified autoref
4 = Autoreference global notes
O5 - 0 = 'o' output to bottom line
1 = output to printer ( -p flag)
2 = to standard text output
3 = to AUX device
4 = to output file (opened by 'w')
+8 = Suppress newline output
O6 - 0 = exit without displaying memory
1 = Display remaining space on exit
2 = Swap HS/HG/HI to disk/XMS on DOS command
O7 - 0 = No tracing
+1 = Trace script labels
+2 = [IDE] log actions / modifiers
+4 = [IDE] log condition tests
O8 - 0 = Don't warn if item not found
1 = Give warnings for item not found
2 = Give warnings for file not found
O9 - 0 = 'T' listing interpret ref flags
1 = 'T' listing give verbatim list
2 = As 1, also strips 8th bit
3 = Display with flags and variables interpreted
30. Extended options
O*0 - 0 = ESC key to input does not cancel
+1 = ESC key to input cancels script
+2 = Cause action modifier error to cancel multiple action
+4 = ESC key during script does not pause
O*1 - 0 = No shadows on popups
1 = Shadow edges on popups
O*2 - 0 = No blinking
1 = Blink mouse cursor
2 = Blink cursor and refs
O*3 - 0 = Mouse cursor, keys step 1
+1 = Suppress mouse cursor
+2 = Cursor keys step as TAB
+4 = Put mouse on first ref. of frame text / paged list
+8 = Do not move mouse to selected reference
O*4 - 0 = Autoref typed files
1 = Autoref files & frames
O*5 - 0 = Accept characters < 128
1 = less than 176
2 = less than 256
O*6 - 0 = Search all frames
1 = Search matching only
2 = Search frames not matched
3 = as for 1 and 2, but reset
4 = to 0 after next search
5 to 9 - as 0 to 4 with non-stop
O*7 - n = Tab width (1 to 9)
O*8 - 0 = No comments on noted refs
+1 = Request comment on notes
+2 = Display matching line in search text list
+4 = Multiple search support (conjunctions)
O*9 - 0 = Key mapping case sensitive
1 = Key mapping case insensitive
31. Colour schemes
A wB Action reference
B Wk(bl) Blink
C KC Menu choice
D KW Default title
E yK Frame reference (replace)
F wK Frame reference (stack)
G KK Popup shadow edge
H KY Menu heading
I yY Input field
J KG Note heading and border
K yG Note
L RK Low intensity
M KW Menu reference
N gK Note reference
O yB Menu selection
P yr(bl) Popup message
Q Kk(bl) XOR mask for ref blink (O*22)
R KW Request / message
S yG Script reference
T WK Frame text
U YK (User 1)
V MK (User 2)
W GK (User 3)
X RK (User 4)
Y BK (User 5)
Z rK (User 6)
32. Colour codes
K Black _black
B Blue _blue
G Green _green
C Cyan _cyan
R Red _red
M Magenta _magenta
Y Yellow (Brown) _yellow
W White (light grey) _white
k Dark grey _grey
b Light blue _lightblue
g Light green _lightgreen
c Light cyan _lightcyan
r Light red _lightred
m Light magenta _lightmagenta
y Light yellow _lightyellow
w Bright white _lightwhite
33. Configuration strings
KH1 - Popup directory heading
KH2 - '?' key mapping for frame display
KH3 - '?' key for paged display (menuname)
KH4 - ESCAPE mapping [ZC]
KH5 - HOME mapping [y]
KH6 - END mapping [ZR]
KH7 - PgUp mapping [y-]
KH8 - PgDn mapping [y+]
KH9 - Backspace mapping [B]
KH0 - Control menu heading
KG1 - Default action for RETURN / LEFT Mouse button
KG2 - Default for RETURN / LEFT Mouse button in typed file
KG3 - Default for ESCAPE / RIGHT button in typed file
KG4 - End of title line for Type file and @G list
KG5 - Variable expansion spec for @G formatted list
KG6 - Selection expression for @G list
KG7 - Format line for @G list
KG8 - Character translation - from string
KG9 - Character translation - to string
KG0 - Frame transition script specification
34. Control menu
KM1 - HOME
KM2 - CONTENTS
KM3 - BACKTRACK
KM4 - SELECT BACK
KM5 - NOTEPAD
KM6 - SEARCH TEXT
KM7 - TYPE FILE
KM8 - DO ACTION
KM9 - DOS SHELL
KM0 - EXIT
35. Error codes
1 - Operation cancelled
2 - No selection from menu
3 - End of file
4 - Cant open file
5 - File not open
6 - File open
7 - File changed
8 - At start of backtrack
9 - Divide by zero
10 - Value not expected
11 - Value expected
12 - Undefined opcode
13 - Unmatched parenthesis
14 - Syntax error
15 - Script not available
16 - Menu not available
17 - Note not available
18 - Frame not available
19 - Key not defined
20 - Invalid key code
21 - Local ref can't be noted
22 - Not at reference
23 - Key not mapped
24 - No action or disabled
25 - Invalid action code
26 - No command
27 - Env var not present
28 - Invalid dynamic menu
29 - Line too wide for screen
30 - String too long
31 - Too many lines in frame
32 - Max script reached
33 - Maximum menu size reached
================ INTEGRATED ENVIRONMENT REFERENCE =================
36. Edit actions
#Atname~tafter Add item and enter edit mode. add(item,after)
#atname~tfrom Add item, copied from other copy(item,from)
#Bmessage Load paged list message/edit string before(string)
#Ctname Check item. check(item)
#Ftname Find item, set 'd' or 'u' lookfor(item)
#Mtname~tafter Move item. move(item,after)
#Dtname Delete item. delete(item)
#Utname~tafter Undelete item. undelete(item)
#Vtname view item. view(item)
#Etname edit item. edit(item)
#Onvalue Edit option setting editopt(opt,val)
#Lmmmmm; Left margin default string for frame lmargin(mmmmmm)
#Wnn Right margin default for frame rmargin(nn)
#Ptname Print item, interpreting flags. print(item)
#ptname Print item verbatim (no interp). printv(item)
#Rtname~tnewnm Rename or change details. rename(item,to)
#TFframe~newtit Change title string for frame. rentitle(item,to)
#Ztname zap deleted item. zapdel(item)
#X save and exit. savexit()
#Yfilename save as 'filename' and exit saveas(filename)
#Q quit with no saves. quitedit()
#QQ delete change file, and quit no save quitedit(Q)
#S save file and continue. save()
#I Incremental save. saveinc()
- Save changes and index, can Q after this and
index and changes will be read on next run of HI
#Knnn string Set config string (edit key mapping) setconfig(nn,str)
Parameters
'tname' (and tafter etc) is made up of 't' and 'name'
't' is the item type specifier
N,n,M,m,S,s - as expected
F - FRAME
R - REMARK t_remark()
E - END t_end()
P - PRINT directive t_print(directive)
C - CHECK directive t_check(settings)
T - Text file t_file(filename)
Extra types
These types may be specified for certain operations
U - HEADER t_header()
V - FOOTER t_footer()
I - INDEX t_index()
Z - SHARE t_share()
37. Extra dynamic menus
@I Global item list globals()
@i Local item list locals()
@Z Deleted item list deleted()
@P{n}{title} Global item popup menu globalpop(n,title)
@p{n}{title} Local item popup menu localpop(n,title)
Values for 'n' are
0 MENU
1 NOTE
2 SCRIPT
3 PRINT
4 CHECK
5 REMARK
6 END
@Ystring Global item search searchglob(string)
@ystring Local item search searchloc(string)
@U Check frame texts checkframes()
@V Check global items checkglobal()
@v Check local items checklocal()
38. Flags in lists
blank Item is in original file
M Item is in memory
C Item is in the change file
R Item is readonly control item (not displayed)
? Item failed last scan check
39. Extra Functions
&f{d} Free space on default (specified) drive
&l Length of current hyperfile
&idefault Input text from current screen position
&0 to &9 Edit mode variables
0 is macro
1 is search string
2 is replace string
3,4 are user definable
5 is edited item name
6 is edited item type name
7 is last deleted (part) line
8 is kill buffer
9 is left margin
40. Environment options
Set via #Onvalue, where n is one of
0 1 Create backup on save (set by -eb)
1 0 (Create file -ec)
2 1 scrollbar (0 = none, 1 = scrollbar)
3 0 assumed indent (for edit mode/checks)
Run option values for &R
28 Edit location (0 = in memory, 1 = from file '-ef')
29 Number of edits so far
41. Edit mode primitive function codes
A Autoref global
a Autoref local
B Beginning of line
b Beginning of word
C Toggle cursor tracking (actual / displayed)
cspec Convert according to 'spec' (see CALL extns)
D Delete current char
d Delete previous char
E End of line
e End of word
F Autoref from frame list
ffspec Append file
Gnn Goto line number nn
gnn Goto column nn
H Toggle flag interpretation
hnspec Popup note
I Toggle Insert/Overwrite
iispec Append item
J Join lines
j Fill / justify / centre paste buffer
K Kill (delete) current line
kstring Load kill buffer
L Insert newline character
l Set temp left margin
M Toggle margins
m Set position at mouse (or scrollbar)
N Next page
n Next line
O open line before
o open line after
P Prev page
p Prev line
Q Quit edit
q Save edit buffer to EDITBUFF.SAV
R Refresh screen
r Set temp right margin
S Toggle symbol shift
ssspec Insert string
T Insert TAB character
tfspec Append text screen
U Undelete line as separate line
u Undelete line inline
V Verbatim character (from keyboard)
v Verify (Check) edit buffer
W wipe reference flags from word
wfspec Append screen with attributes
X Exit edit with save
xsspec Execute function string
Ymessage Ask for confirmation (multiple action line)
ystring Search for string and position cursor
Z Delete to start of line
z Delete to end of line
0 User settable
1 edit mode
2 variables for
3 use with &0 to &4
4 functions
# Store current column,line in &3,&4
. Mark start line
- Cut from start line
+ Paste cut lines
^ Paste first line 'in line'
/filename Save paste buffer to named file
=c actual character 'c'
* copy character from mouse position
< Previous char
> Next char
{ Beginning of paragraph (first line)
} End of paragraph (last line)
( Start of repeat range (must have ; after)
) End of repeat range (end of multi-string)
!action Do action (limited actions only !!!)
Parameters - nspec,fspec,sspec,ispec
Can be a literal string or from action modifier
nspec Note spec = tname,Nname,nname
ispec Item spec = nname,Nname,mname,Mname,sname,Sname,Fname
fspec File spec = filename.ext
sspec String = any string
42. Graphics characters showing mappings in Symbol shift
`abcdefghijklmnopqrstuvwxyz+,./{}| 3 4 5 6 7 8 9 = ; : @ < >
αßΓπΣσµτΦΘΩδ∞φε∩≡±≥≤⌠⌡÷≈°∙·½¼«»√²ⁿ │ ┤ ╡ ╢ ╖ ╕ ╣ ╜ ╗ ║ └ ╝ ╛
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
┴ ┬ ├ ─ ┼ ╞ ╟ ╚ ╔ ╩ ╦ ╠ ═ ╬ ╧ ╨ ╤ ╥ ╙ ╘ ╒ ╓ ╫ ╪ ┘ ┌
┌─┬─┐ ZDBD? ╔═╦═╗ IMKM; ░ 0 â ä à å Ä Å á
├─┼─┤ CDED4 ╠═╬═╣ LMNM9 ▒ 1 Ç ç
│ │ │ 3 3 3 ║ ║ ║ : : : ▓ 2 é ê ë è É
└─┴─┘ @DADY ╚═╩═╝ HMJM< █ [ ï î ì í
¢ £ ¥ ₧ ƒ ⌐ ¬ ¡
╒═╤═╕ UMQM8 ╓─╥─╖ VDRD7 ▌ ] ô ö ò Ö ó
│ │ │ 3 3 3 ║ ║ ║ : : : ▐ ^ ü û ù Ü ú
╞═╪═╡ FMXM5 ╟─╫─╢ GDWD6 ▀ _ æ Æ
╘═╧═╛ TMOM> ╙─╨─╜ SDPD= ▄ \ ÿ ñ Ñ ª º ¿
43. Default Key Mappings
Enter - Insert new line / break current line
Backspace - Delete previous character
Escape or Right Mouse - Edit menu
LEFT Mouse - Position cursor / use scrollbar
Cursor Up,Down,Left,Right - Prev line, Next line, Prev char, Next char
Home, End - Beginning of line, End of line
Ctrl Home, Ctrl End - Go to start of word, end of word
Page Up, Page Down - Previous page, Next page
Ctrl PgUp, Ctrl PgDn - Go to start, end of buffer
Insert - Toggle Insert mode
Delete - Delete next character
Ctrl Left, Ctrl Right - Delete to start, end of line
44. Control Keys
^A - open new line After current
^B - open new line Before current
^D - Delete inline (from ^X position)
^E - Enter EDIT command
^F - reformat paragraph
^G - Toggle flag interpretation
^J - Join current line to next line
^K - Kill (delete) current line
^L - Set temporary Left margin
^N - Save edit buffer to file EDITBUFF.SAV
^O - Toggle margins (clear temporary margins)
^Q - Quote verbatim character (next char typed)
^R - Set temporary Right margin
^T - Toggle cursor Tracking (actual / visible char)
^U - Undelete line
^V - Verify (check) buffer
^W - Wipe reference flags
^X - Mark start for inline cut (^D to cut)
^Y - paste in line
^Z - duplicate character from mouse position
45. Function Keys
UNSHIFTED SHIFT(flag as) CONTROL (insert) ALTERNATE
F1 - Help menu Frame step Frame reference Frame autoref
F2 - Refresh Frame ref Global item ref Global note autoref
F3 - Macro (check) Global note Local item ref Local note autoref
F4 - Swap with mark Local note Append Frame Search/replace
F5 - Mark for cut Global menu App Global item Search again
F6 - Cut from mark Local menu App Local item Search for string
F7 - Paste lines Global Script App File text Copy to kill
buffer
F8 - Symbol shift Local Script App Screen file Paste kill buffer
F9 - QUIT edit Action App Screen (att) DOS exit
F10 - Save & exit Input field App saved buffer Save PASTE buffer
---------------- COMMAND LINE OPTIONS --------------------
46. HS - HyperShell Reader
hs {options} hyperfile {frame}
-n Restart file for notes
-r Restart for notes,variables,frame
-s Save screen for redisplay on exit
-m Force use of mouse emulator
-f Suppress symbols on menus
-b Suppress backtrack recording
-a Switch on autoreferencing
-u Display available memory on exit
-x Suppress file suffix on notepad
-t Trace labels in scripts
-h MDA/Hercules/mono EGA/VGA highlighting scheme
-g{n} CGA/EGA highlighting scheme
(n=0-CGA,1-Herc,2-EGA,3-VGA)
-z Flash mouse cursor
-l Verbatim Type file listing
-k Verbatim and strip 8th bit
-d Use BIOS for display
-q Stop Crl-C/Ctrl-Break
-vVstring Set variable V to string
47. HI - HyperShell Integrated Environment
hi {options} hyperfile {frame}
OPTIONS AS FOR HS - PLUS
-ef Work against file, rather than in memory
-eb Delete original, rather than saving as .BAK
48. HC - HyperShell Checker
hc {options} hyperfile
-t suppress audit trail
-h translate .HSL source to .HYP first
-j just translate .HSL file
-dname=defn define source variable (name=val)
-ifile include file
-l list complete hyperfile
-n suppress line numbers in listing
-e list with embedded errors, (sets -l, -n and -o)
-c create unrefd frames etc
-u suppress error messages for unrefd items
-g extended autogeneration (sets -e -c -u -o)
-b autoreference
-k{xxx} extended autoreference (sets -l -n -u -b -o)
x=f-frames,n-notes,m-menus,s-scripts
-y interactive autoreference
-o produce file filename.CHK
-a do action checks for menus with actions
-x suppress menu length check
-f do frame reference checks for menus without actions
-p suppress frame length check (paged frames)
-r produce reference counts
-s suppress summary totals
-z produce cross reference file
-m suppress duplicate checks
-q suppress unreferenced item list
-w suppress warnings
49. HP - HyperShell Print program
hp {options} hyperfile {frame name}
-p output straight to printer
-e output to printer using Epson effects
-z output to printer using Laserjet/Deskjet effects
-l with -p, -z or -e, set letter quality
-tn assume tab size of 'n'
-mn assume left margin on frames of n
-hnn page height nn rather than 66
-s soft formfeeds
-n Do not do page breaks, or index
-w Format for word processor (sets -n)
-d use default heading, rather than first title
-r list reference details after frame
-g include notes (glossary)
-f full list including items
-o print one frame (with notes if -f)
-i ignore print directives
-a stop and ask before each new page
-v configuration file diagnostic display
-cfilename use filename{.hsf} as list of frames to print
if no filename use RESTART.HSF
-j ignore ~p flags
-b Page break for each frame
-k Do not print frame side headings
-usssss Left title string
50. HCX - HyperShell Compress program
hcx {-c/-r/-s){-x/-p/-o/-n}{-t} file
COMPRESSION
-c compress
-r rename
-s secret (one way compression for primary hyperfile only)
EXPANSION
-x expand to file
-p paged display
-o expand to output
-n just show filename
BOTH
-t remove/add <CR> chars
51. TAGBLOAD - BLOAD image tagger
tagbload filename.ext {mode}
Mode Resolution Colours
0 or 1 40x25 text - 16
2 or 3 80x25 text - 16
4 or 5 320x200 graphics - 4
6 640x200 graphics - 2
7 80x25 text - Monochrome with attributes
7 720x350 graphics - Hercules monochrome
13 320x200 graphics - 16
14 640x200 graphics - 16 (1 showing)
15 640x350 graphics - 4
16 640x350 graphics - 16 (1 showing)
17 640x480 graphics - 2
18 640x480 graphics - 16 (1 showing)
54 to 59 and other special modes may also work, depending on adaptor
52. HYPOP - HyperShell subset popup program
hypop filename.ext install
hypop -u uninstall
Invocation Hotkey is Alt-/
Subset specification
.FRAME name (up to 35)
.TITLE title string (up to 35)
Text up to 22 lines of 79 columns maximum (truncated).
Default mode referencing uses reference flags ~F and ~E
.REMARK AUTO - Automatic mode referencing
.REMARK LINES nn - Set part screen depth
.REMARK SCHEME nFB. - Set colour scheme n is one of:-
0 = Main display text
1 = Title
2 = Reference
3 = Highlighted reference
.REMARK OPTION n - Set options where n is one of:-
1 - F9 will NOT leave screen on display
.REMARK TEXT nn New text string - Configure text
Operation
Keys TAB, BackTAB, cursors, alphabetic keys, to move.
RETURN to select.
PgUp PgDn and Home move about pages of frame
End redisplays the saved screen
+ and - move to next and previous frames.
F1 goes to frame 'Help' (or 1st frame if none)
F2 goes to first frame and resets backtrack
F3 is backtrack
F4 toggles part/full screen
F6 asks for a context word to search for
F9 exits, leaving screen on display
F10 key or the ESCAPE key exits
53. HRXFP - HyperShell Floating Point
hrxfp -i install
hrxfp -u uninstall
---- Functions
sin, cos, tan, atan, asin, acos, log, ln, sqrt, exp
abs, floor, ceil, rand
c_i, i_c centimetre, inch
m_f, f_m metre, foot
k_m, m_k kilometre, mile
k_p, p_k kilogram, pound
g_o, o_g gram, ounce
l_g, g_l litre, gallon
d_r, r_d degree, radian
c_f, f_c centigrade/celsius, fahrenheit
---- Options
#d - decimal
#o - octal
#x - hexadecimal
#b - binary
#c - character
#pn - decimal places
#snnn - set random seed as nnn
54. NGHS - Norton Guide to hyperfile convertor
nghs {flags} guidename.ng
-m Local menu for See Also references
-v verbose
-p popup
-a adjacent titles
-tnn title position
55. NOTE - Simple note editor
note {options} filename.ext
-ttitle Title string (default=filename)
-lline Start line for window
-ddepth Depth in lines
-ccolumn Start Column for window
-wwidth Width in Columns
-bborder Border style for window (0 to 9)
-sFBfb Highlighting schemes
-a Start in autoformat mode
-v View mode - no edits
-f fold overlength input lines (otherwise truncated)
-rnn restrict editing to max nn lines
-h Help display
Edit control keys
ESC - Menu bar
cursor keys - up,down,left,right
PgUp,PgDn - Prev, Next page
Home,End - Start,End of line
Ctrl-Home - Start of file
Ctrl-End - End of file
Ctrl-T - Top of window
Ctrl-B - Bottom of window
Ctrl-Right - Next word
Ctrl-Left - Previous word
Ins - Insert / Overwrite
Del - Delete next char
Backspace - Delete prev char
Ctrl-A - Auto format
Ctrl-F - Format para
Ctrl-N - New (clear buffer)
Ctrl-D - Delete word
Ctrl-Y - Delete line
Ctrl-Q - Quit, no save
Ctrl-X - Exit with save
Ctrl-V - Allow entry of graphic characters
Ctrl-L - Line draw toggle
F1 - Help
F2 - Begin block
F3 - End of block
F4 - Unmark block
F5 - Move block
F6 - Copy block
F7 - Delete Block
F8 - Delete Line
F9 - Quit, no save
F10 - Save and exit
56. HSORT - Hyperfile index sort
hsort source.hix target.ext {type}
type is:-
0 (default) produce .HIX format
1 produce .HIX format (sort case insensitive)
2 produce contents list format with key mappings
3 contents format (sort case insensitive)
4 produce data file format frame~title~address
5 data file format (sort case insensitive)
above + 8 do not do sort - output unsorted
57. HSHOW - Graphic file display program
hshow {flag} filename.ext {flag} filename.ext . . .
Where flags are:-
+ reset to text mode after following image(s) (default)
- leave in graphics mode after following image(s)
= do not wait for key press on following image(s)
58. HPREP - Text preparation program
hprep {options} infile.ext {outfile.ext}
1. -h Fill hyperfile frame and note text
-inn Note Indent (0), -nnn Note Width (40), -v Verbose
[In hyperfile:- .REMARK FORMAT OFF/ON]
2. -f{x} Fill text file (x=c-centre,x=j-justify)
(1,2) -lnn Left margin (8), -rnn Right margin (72)
3. -c Clean file (strip trailing spaces etc)
4. -w{nn} Wrap long lines at nn (72)
-a{cc} (with w) extract ASCII characters (cc = classes)
Class x-alnum,l-alpha,a-(0-127),t-tab>spc,c-ctrl(0-31),s-spc/ff
d-digs,p-prtblr,g-graph,f-accent/greek,m-maths,e-extd(>127)
5. -x{nn} Extract text strings of length nn (3) or greater
(4,5) -u Fold 8 bit to 7 bit chars before processing
6. -t{n} Detab file at tab 8 {n = at tab size n}
7. -s oldstr newstr Replace oldstr with newstr
8. -d{p} Hexadecimal dump of file {paged}
9. -j{XX} Join files (X=F-.FRAME,T-.TITLE,N-.NOTE,Z-File)
10. -z from to Convert from ASCII value to ASCII value
11. -p{x} Join lines in paragraph (for word processor)
12. -e from to Extract range of lines from text file
13. -b Count items in file (no output file)
14. -m Convert to mixed case text
15. -q key Encrypt or Decrypt a text file using a key
(All) -o Overwrite output file
59. HSPELL - Hyperfile spell check
hspell {options} file
options
-t check a normal text file
-e extract text from hyperfile for other purposes
-v print plausible derivations (only use with t)
-x print plausible stems (only use with t)
-D dict specify alternate dictionary
-I index specify alternate index file
-R rule specify alternate rule file
-C cachesize word cache size
-g include graphic characters in check
-i produce item list instead of editor input file
60. HFIND - File and text finder
hfind options string file.ext
options
-i get file names from standard input
-c case sensitive search
-t display count of matching lines only
-f filename read search strings from filename
-n display names of files containing the string
-o display byte offset of matching strings
-s silent - return only success (0) or failure (1)
-w display matching whole lines only
-e string next parameter is search string
-p suppress display of file names
-h produce HyperShell selection list
-b HTYPE file reference list
-r search files in subdirectories as well
-g do global search of whole disk
-l locate filenames on disk
(if used with -r, just subdirectories of current)
-a restrict search to files with archive bit set
-d command confirm and perform command on file
-q with -d, don't confirm before performing command
search responses
space continue - will resume the function
s skip - continue, skipping this file/directory
q quit - will stop the function
c will change to the displayed directory and quit
a if doing commands, confirm each before processing
other keys quit - will stop the function
confirmation responses:-
y yes - perform the command
Enter yes - perform the command
g yes - do this, and continue without confirmation
n no - continue search
s skip - skip rest of this file
q quit - stop search
Escape quit - stop search
c change directory and stop
other key - continue search
61. HTYPE - File browser
htype {options} {filename.ext}
options
-fstring find string in file
-lnnn Goto line nnn in file
-snnnn Start at line nnnn as line 1
-w Wrap text to fit page
-x Display text in binary file
and wrap text to fit page
-m Suppress mouse handling
-d Show detail line for files
Configuration scheme numbers
0 - normal colour - main file display text
1 - highlight colour - file detail line in picklist
- search items located in file display
2 - inverse colour - top / bottom border, current picklist item
3 - blink colour - error messages
4 - picklist colours - text in picklist
5 - help colours - text in help displays
PickList mode key mappings
F1 - Help display
F2 - Display A - Z mappings
F3/DEL - Move up one directory level
F4 - Exit at current directory
F5 - Find file using HFIND -l
F6 - Find string in files using HFIND
F7 - Toggle binary/text viewing
F8 - Prompt for command and run on file
F9 - DOS Shell escape
F10/ESC - Quit
TAB - Toggle file details display
Cursors - Move around files
Enter - Select file for viewing
PgUp / PgDn - Previous / Next page of files
File display mode key mappings
F1 - Help display
F2 -
F3 - Backtrack to previous file (if file reference)
F4 - Exit in current directory
Home - Top of file
PgUp - Up one Page
Up ^ Line
Cursors Left 10 < + > Right 10 chars
Down v Line
Ins - Left edge
PgDn or SPACE - Down one Page
End - Bottom of file
/ or F6 - Scan (case sensitive)
\ or F7 - Find (case insensitive)
F5 - Find / Scan next
TAB - Toggle fold on search string
# - Go to line number
[ - Mark block start
] - Mark block end
- - Clear block marks
> - Write block to file
(give filename of PRN to print block)
= - Go to block start
F8 - Run command on file (asks for command)
F9 - DOS Shell
q, Esc or F10 - Exit HTYPE program
f or RETURN - follow link at top line
h - follow link at mouse
x - re-enter in binary / text mode
c - continue truncated file
62. HSRES - Resident swapper for HyperShell
hsres {options}
/1 single swap file
/A visible attribute for swap files
/C on-screen configuration
/D force disk swapping even if EMS/XMS available
/Fkbytes specify approx. kbytes free within DOS shell
/Hhyperfile specify hyperfile to activate. $-variables allowed
/Khexkeys specify TSR hot keys in hex
/M disable swap message
/Pprogram chose as program HS, HL or HI
/Rframe specify hyperfile frame to show. $-variables allowed
/Spath specify path for swap files. $-variables allowed
/U unload TSR
/V remove mouse management code
/X Choose XMS over EMS
/? or ? show the command line options
The "/" option prefix may be substituted by "-". Spaces are not allowed
inside command line options, and the options must be separated by
spaces.
The "switching" options, eg. /1, will switch the option back and forth
when mentioned several times. The other options, like /S, will retain
the value from the LAST time they are mentioned.
Options may be placed in a configuration file, as described below.
$-variables - Transferring data to HSRES
You can transfer data from the running application to HSRES by means of
$-variables. These variables will be evaluated and replaced in the
HSRES configuration at the time of installation or popup.
There are four types of $-variables:
$ Word from text cursor position
$(x,y) Word from x,y screen position
$(?prompt) Ask the user for a value
$(EnvVar) Value of environment variable
63. HPAINT - Paint program
hpaint {options}
options are as follows:-
-l low res - 640x200 in 16 colours
-m medium res - 640x350 in 16 colours
-h high res - 640x480 in 16 colours
-c CGA mono - 640x200 in monochrome
The default mode is the highest resolution supported by the adaptor.
Key mappings
h/F1 - help display
z/F3 - toggle control panel display / full screen
s - stage save, for undo stages within tool selection
u - undo to last tool selection
c - clear screen
m - show available memory
P - Print screen as per PRNT selection set
r - refresh (redraw) screen
A - Adjust palette for foreground colour. Keys then as follows
r - red up R - red down
g - green up G - green down
b - blue up B - blue down
1 thru 9 - set increment for above adjustments (default 1)
d load default palette for the current colour
# load default palette for ALL COLOURS
u or U - undo change to current colour (since A was pressed)
d/F2 - directory list for file type, allowing selection with mouse
Q - quit without confirmation (use with care)
F10 - quit with confirmation
64. HRESED - Resource editor
Usage: resed {options} {filename.ext} {secondfont.ext}
-it icon - where t is:-
wide deep (default is 32 by 32)
n 24 28 (narrow EGA)
w 32 28 (wide EGA)
l 40 32 (large VGA = maximum)
s 16 14 (small EGA)
v 16 16 (small VGA)
-wnn width
-hnn height
-tc Set transparent background in .ICO to colour c
(where c is in HyperShell colour set) else set transparent
-m mouse cursor - 16x2 by 16
-fdd font height dd = 8,14,16
-onn font at offset nn
-cnn convert an nn deep font to 16 (or -fdd depth)
eg. hresed -c14 font8.udg font16.udg
hresed -f8 -c14 font14.udg font8.udg
-b use the BIOS font for the main font (with -fdd) or the
second (default) font when editing filename.udg
Z command - global font processing options
NOTE: if uppercase character is inverted before operation applied
o - OR current character with all characters in font
a - AND current character with all characters in font
x - XOR current character with all characters in font
z - no operation. Used as 'Z' to invert all characters
m - mirror character left->right and right->left
f - flip character top->bottom and bottom->top
l - shift character left one pixel
r - shift character right one pixel
u - shift character up one pixel
d - shift character down one pixel
v - rotate character for vertical print
j - clear alternate lines horizontally
s - superscript (condense character to upper half of cell)
n - shadow after character
b - bold horizontally
h - bold vertically
i - italic
w - wavy character
_ - underline character
65. HGPREP - HyperShell Graphic Preparation
Usage: hgprep {options} filename.ext
options are as follows
-i Show information only
-v Show details of processing
-c Convert to PCX same number of colours
-k With -c, choose area to convert as 320x200
-r{t} Reduce 256col picture to PCX 16col
t is Dark threshold (1 to 4)
-h{n} Halftoning. Bright threshold n = 1 to 8 (default 4)
-z Random halftoning instead of checkerboard
-bnn nn = (-7 thru 7) - Adjust brightness
-aadj Adjust colours for conversion
rnngnnbnn nn is % adjustment (-90 to 500)
eg. -ar20g-30 increase red by 20%, reduce green by 30%
-q Produce quad image (times 2)
(-a -b -h -q and -z are for use with -r)
-sn Supervga mode for showing large 256 colour GIF images
1 - Paradise, 2 - Trident, 3 - Tseng, 4 - ATI, 5 - vgahi
-m Convert 256 colour lowres .PCX to mode 19 .HGP
-t Convert 256 colour mode 19 .HGP to lowres .PCX
-x Extract palette from PCX (16 or 256)
-p Convert palette defn to PAL
-o Overwrite existing output (otherwise aborts)
66. HCOMP - Compression control
Usage: hcomp flags filenames
flags are:-
-cext compress files and add extension ext
-f force compress (used with -c)
compress even if output is uptodate
-xext expand files and add extension ext
-q do it quietly - no messages
67. HLIB - Command line
Usage: hlib {flags} libname filenames
{flags} are:-
-v verbose audit trail
-o overwrite library
-t EOFs between text files
-x extract named files
-l list library
Default library extension is .HLB
68. HCAP - capture screens
HCAP - capture any screen as one plane BLOAD
HCAPX - capture any screen as one plane BLOAD
HCAPPCX - capture colour and mono EGA/VGA screens as .PCX
all 16 colour 640 pixel wide screens
HCAPVGA - capture 256 colour 320x200 VGA as .HGP
69. HFONT - Load font file for text mode
HFONT fontname.udg {x}
EGA requires 14 deep font
VGA requires 16 deep font
optional parameter x causes display of full character set after
loading font.
70. HPG - Graphics print
hpg l - print screen to laserjet
hpg e - print screen to epson (not yet available)
hpg f filename - save screen to file as .PCX (no palette!)
71. CONVSND - Convert sound file
Usage: convsnd (fromname.ext) (toname.ext) [samplerate]
samplerate is 11000 if not entered.
Valid input file types:
.WAV Microsoft WAVE file.
.VOC Soundblaster RAW .VOC file.
.GSS ???
.SND A raw file.
.RAW A raw file.
.VMD A raw file.
.HSN HyperShell format raw file.
Valid output types are .WAV, .RAW and .HSN.
72. CTaudio - Audio Compact Disc control for CD-ROM drives
Call: CTaudio <parameters>
parameter: meaning: returns EL:
--------------------------------------------------------------------------
index tell disc contents highest track no
<track> play audio track current track
<fromtrack> <ToTrack> play audio tracks first track no
<min:sec> play from time first minute
<min:sec> <min:sec> do. for specified time first minute
Note: Format can also be <min:sec:frame>
all play all tracks first track no
status show status once current track
status loop <row> <col> show continuous status
at screen pos (default 1,1) current track
stop pause/stop audio 0
resume resume audio from pause 0
CTaudio returns DOS Error Level (EL) > 100 on error conditions.
All output (except status loop) can be redirected to eg. nul.
Status loop mode can be changed with F1, and terminated by any other key.
73. HyperShell File Extensions
.HYP Hyperfile
.HIX Hyperfile index
.MNU Menu file
.HSF Script file
.NTE Note file
.CFG Configuration file
.HXC Integrated environment index file
.TMP IDE temporary file
.BAK IDE Backup file
.HCM Compressed file default extn
.HXP Expanded file default extn
.PIC BLOAD image
.PCX Microsoft Paintbrush image
.DAT Database or data file
.TXT Raw text file
.HSL HSL source file
.HSI HSL include file
.CHK HC check output file
.XRF Cross reference
[G] Graphic system files
.HGP Bitmap clipping
.HMC Mouse cursor
.UDG Font file
.TIC Draw sublanguage script (pixels)
.PAL Palette file
.HLB HyperShell library
.AGD Supercompressed file
.HSN HyperShell sound file
.BMP Windows bitmap file
.ICO Windows icon file
.WAV Windows sound file
===== END OF DOCUMENT =====